home
***
CD-ROM
|
disk
|
FTP
|
other
***
search
/
BBS Toolkit
/
BBS Toolkit.iso
/
doors_1
/
hsldr26b.zip
/
HSLDOOR.DOC
< prev
next >
Wrap
Text File
|
1992-01-04
|
15KB
|
329 lines
┌─────────────┐
│ HSLDOOR.EXE │
└─────────────┘
HS/Link Bi-Directional File Transfer Door
Tom Kellen
ßETATech Computer Consulting
Version 0.23ß
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
PURPOSE: To provide a means for Spitfire SysOps to implement
HS/Link's Bi-Directional file transfers.
INTRODUCTION:
I've just begun playing with Samuel Smith's HS/Link file transfer
protocol. So far it has yielded impressive results, but alas,
Spitfire BBS does not yet implement support for Bi-Directional
protocols. HSLDoor should make full use of this protocol on a
Spitfire BBS possible.
INSTALLATION:
HSLDoor assumes that you have read the documentation for HS/Link
and have used HSCONFIG to configure your copy of HS/Link. HSLDoor
imposes very little control over HS/Link. HSLDoor also assumes
that HSLINK.EXE resides in a directory that is on your PATH (hmmm,
that's a lot of assumptions).
Create a directory for HSLDoor. For documentation purposes we will
assume that you are using C:\SF\HSLDR. Copy HSLDOOR.EXE and
HSLDOOR.CFG into this directory.
You will need to modify at least 2 lines in HSLDOOR.CFG (any text
after the ; are considered comments and ignored). Here is an
example configuration file:
=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=
BBS=The Paradigm BBS; Your BBS Name
REGNO=000000; Registration Number, leave as 000000 if unregistered
DEST=F:\UP\; Final destination for uploaded files
LOG=C:\LOGS\HSLDOOR.LOG; Log to this file instead of CALLERS.TMP
-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-
The first line is the name of your BBS. This will be displayed as
the door closes and will also be displayed on all menus once you
register the door.
The second line is your registration number. If you are still
evaluating the door and have not registered, leave this as 000000.
The third line is the destination path for all the files uploaded
through HSLDoor.
The fourth line is an alternate log file. By default HSLdoor logs
to CALLERS.TMP for the node that called it so that all information
will be placed in CALLERS.LOG. If you wish logging for this door
to go elsewhere, add a line like above using the key word LOG=.
This line is optional and if omitted, all logging will go to your
caller's log.
If you don't want to have the beeps the door makes echoed on the
local side (ie. sweet silence mode) then place the key word NOBEEP
on a line in HSLDOOR.CFG.
By default the door allows users to log off following a file
transfer. The door will log this but Spitfire will also place a
line stating "Improper return from door...". This just means that
the door dropped carrier. If you wish to disable the ability for
users to log off via the door, place the key word NOLOGOFF on a
line in your HSLDOOR.CFG file.
As an added bonus to your users, you have the option to allow them
free downloads to encourage the use of HS/Link and HSLDoor. By
default, the door credits uploads and downloads just the same way
Spitfire does. If you wish to allow the users to download through
the door and not be charged for the downloads, place the key word
FREEDL on it's own line in HSLDOOR.CFG. If this key word is
present, the users will not be charged for their downloads.
The lines in your HSLDOOR.CFG file (and it must be called this) can
be in any order but they must start with the key words BBS=,
REGNO=, DEST=, LOG=, NOBEEP, NOLOGOFF, and FREEDL. The first 3 are
required, the 4th - 7th are optional.
Once you have completed this, you will need to modify your SF.BAT
to install this door. This is pretty straight forward, and like
any other Spitfire door. Here is a snippet from my SF.BAT:
=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=
:DOOR_H
REM HS/Link Transfer Door
cd\sf\hsldr
copy c:\sf\sfdoors.dat
HSLDOOR
erase sfdoors.dat
CD \SF
GOTO LOOP
-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-
This snippet is also included in the distribution ZIP as SF.BAT.
Just remember to copy SFDOORS.DAT (or one of the other SFxxxx.DAT
files if running from a menu) to the HSLDoor's directory. HSLDoor
needs this information and will update the master copy in your node
directory after it has run. If you are running multiple nodes of
Spitfire you can call HSLDOOR with a /DAT= on the command line
indicating the path to the SFDOORS.DAT file you wish to use. (ie.
HSLDOOR /DAT=C:\SF01) When you use /DAT= on the command line you
do NOT have to copy the .DAT file to the HSLDoor directory. This
should allow multiple nodes to access the same copy of HSLDOOR.EXE.
HSLDoor can also be run from a menu extension. It is able to read
all of the .DAT files (SFDOORS.DAT, SFMAIN.DAT, SFMESS.DAT and
SFFILE.DAT). Just make sure you copy the correct one or indicate
the path to the file using /DAT=.
NOTICE: HSLDoor will NOT operate correctly under WildFire.
WildFire does not faithfully recreate the SFxxxxx.DAT
files and all the information that HSLDoor needs to
operate is not contained in the .DAT files it creates.
The final step is to edit your SFDOOR.MNU file and add a line for
this door. See your Spitfire manual if you need more information
on this.
That should get you going.
OPERATION:
The first time HSLDoor is run it will create a directory under it's
home directory called HSLTRxx.WRK (the xx is replaced with the node
number calling HSLDoor, ie. HSLTR01.WRK). HSLDoor uses this
directory during file transfers. DO NOT use this directory or copy
any files to it as HSLDoor deletes all the contents when it is
through working.
When a user runs HSLDoor, it reads the SFDOORS.DAT file to get all
the vital information. It then goes out and get's a list of all
the directories that this user should have access to based on the
information you have configured for your BBS (this is stored in
SFFAREA.DAT).
From the door's main menu, the user has 5 choices.
[ D ] takes the user to a menu where they can work with files
for download. The Download menu has 7 options.
[ A ] This allows the user to create a list of files to
download. It will create a listing of up to 100
files or the maximum allowed for that user, based on
time and daily download limits. If the file is
available to the user, it is added to their list and
they are notified of the byte size of the file.
[ E ] The user can use this option to edit their queue of
download files to remove some if necessary.
[ F ] This is a simple file find that allows wildcard file
name entry. The user will be prompted whether they
wish to add the files found to their download queue.
[ L ] This presents a listing of the files currently in
the user's download queue.
[ S ] The user can begin their HS/Link file transfer from
this menu by selecting this option.
[ U ] This will change the user to the Upload Menu.
[ Q ] And of course we can quit back to the main menu.
[ U ] takes the user to a menu where they can manage the files
they intend to upload.
[ A ] Allows the user to create a list of the files they
will upload. They are prompted for file name and a
45 character file description. The file names are
checked against the files currently on the BBS and
duplicates are rejected. SFNOUP.DAT is also checked
and files found on this list are rejected. If you
have set description conversion on for your BBS,
HSLDoor will also change the file descriptions to
proper case and upper case any words founds in
SFUPCASE.DAT. If the user starts the description
with a '\' character the upload is considered
private and for the sysop only. The file will be
copied to the area defined in your HSLDOOR.CFG file,
but instead of the SFFILES.BBS listing in that
directory being updated, HEYSYSOP.LOG in your work
directory will be updated with the file information.
[ D ] This will take the user to the Download Menu.
[ E ] Using this option the user can edit their list of
files to upload and delete entries if needed.
[ L ] This option will allow the user to view the list of
files they have queued for upload.
[ S ] The user can start their HS/Link transfer from this
menu by selecting this option.
[ Q ] This option returns the user to the main menu.
[ V ] Allows the user to browse the file listings from the BBS.
They will be presented with the descriptions of the file
areas available to them. They can enter the number of a
file area to view, or page forward in the description
list with <N> or back in the list with <P>. <Q> will
return the user to the main menu.
Once the user has completed creating their upload and download
queues they can select [ S ] start their HS/Link transfer. All of
the files uploaded will go into the HSLTRxx.WRK directory. Once
the transfer is completed, HSLDoor will check the files uploaded
with the list the user provided. If they uploaded different files,
the user will be asked to provide a description for those files.
Once the door has all the descriptions for all the files, they will
be moved from the HSLTRxx.WRK directory to the destination
directory you specified in the HSLDoor configuration file. The
SFFILES.BBS file (or HEYSYSOP.LOG if a private upload) in this
directory will also be updated with the file name, size, date
uploaded, and description.
The final [ Q ] option exits the user from the door.
HSLDoor will log it's transactions to your caller's log for
informational purposes. When the user exits the door, HSLDoor will
update the master copy of SFDOORS.DAT so that the user is credited
for their uploads and downloads.
HSLDoor will also credit the user for time on uploads based on how
you have Spitfire configured to credit time for uploads. HSLDoor
looks to see if you have any upcoming On-Time events and will make
sure that the user's time credit does not take them beyond this On-
Time event. If they amount of time they should be credited is
greater than the time to the next On-Time event, then the user will
only be credited with the amount of time remaining until the On-
Time event.
There are several options available to the SysOp. HSLDoor will
take input from the local side so that if the user needs some help
you can do some typing for them.
Hitting the ESC key, will immediately abort the door and send the
user back to the BBS. You can press F1 and get a short help screen
of the keys available to the SysOp. Use caution here though, as
input from the user will not be processed while this screen is up
(their keystrokes will be processed as soon as you remove the help
screen). The help screen has a 10 second time out on it and will
remove its self after that timeout.
F3 allows the SysOp to take the user into a chat window. Here they
can type back and forth for discussion. The text in both
directions is word wrapped for legibility, and incoming and
outgoing text are different colors on the local side to help
visually differentiate them. To exit chat mode, type ALT/F3 (or
ALT/X). While the user is in chat mode, the no keystroke timeout
is disabled, but the user's door time continues to tick away. The
local side of this chat window is an ANSI screen with a 200 line
scroll back buffer that can be accessed with cursor and PgUp/PgDn
keys. You can also type ALT/S and the contents of the capture
window buffer (up to 200 lines of chat) will be saved to a file
called HSLDOOR.CAP.
F6 will give the user an additional 5 minutes of time in the door.
F7 will take 5 minutes from the user. If there is less than 5
minutes left, time will be removed in 1 minute increments.
F9 will return the user to the BBS with a message saying that the
SysOp has requested them to return. F10 will return the user to
the BBS with NO message.
HSLDoor keeps track of the user's time left in the door and also
estimates the time for file transfers to attempt to limit the
user's downloads to the time available. HSLDoor also has a 3
minute no keystroke timer. The user will be issued messages at 2
min., 1 min. and 30 seconds and then is returned to the BBS.
That's about all there is at this time. Comments and suggestions
are certainly welcomed. I'd like to make this door as useful as
possible.
EPILOGUE:
This is a SHAREWARE utility. The program is NOT crippled and NO
features are disabled. Sending in the $5.00 US registration fee
with the registration form to the address below will get you a
registration number that will remove the [Unregistered Shareware
Version] message and allow your BBS name to be displayed.
Try the door thoroughly until you know in your heart that it is of
use to you, and then send in the registration form and fee. If it
isn't, please let me know what features might improve the door.
HS/Link is Copyright by Samuel H. Smith and you are highly
encouraged to register this superb file transfer protocol.
Spitfire is Copyright by Mike Woltz and is a registered trademark
of Buffalo Creek Software. It is also assumed that you have
registered your copy of Spitfire as this is one superb BBS program.
AUTHOR CONTACT:
Problems, solutions, kudos and ideas are welcomed. I can be
reached at the following:
The Paradigm BBS ßETATech Computer Consulting
404/671-1581 P. O. Box 566742
1200-19,200 Baud 24 Hrs/Day Atlanta, GA 31156-6013
DISCLAIMER:
Use of this program acknowledges this disclaimer of warranty: "This
program is supplied as is. ßETATech Computer Consulting disclaims
all warranties, express or implied, including, without limitation,
the warranties of merchantability and of fitness of this program
for any purpose. ßETATech Computer Consulting assumes no liability
for damages direct or consequential, which may result from the use
of this program."
REVISION HISTORY:
26-NOV-1991 v0.02ß VERY ßeta Initial Release.
See WHATSNEW.TXT for further release and update information.